JavaScript

listObj.clearSearchList Method

Syntax

listObj.clearSearchList([options])

Arguments

optionsjson object

An optional JSON format string that indicates where the search should be performed (client-side or server-side). In the case of server-side search, you can set additional optional properties (listed below)

searchMode Character: Can be set to 'clientSide', 'serverSide' or 'auto'. The 'auto' option performs a server-side search if the List is not 'dirty' (i.e. does not have any unsynchronized edits). Otherwise, it performs a client-side search.
maxRowsnumber: In the case of a server-side search, indicates the maximum number of rows that the search is allowed to return. This property overrides the property that is set in the List Builder on the Search Part pane.
maxPayloadnumber: In the case of a server-side search, indicates the maximum payload that the search is allowed to return. This property overrides the property that is set in the List Builder on the Search Part pane.

Description

Removes any filter previously applied by submitting the Search Part.

Example

var listObj = {dialog.object}.getControl("LIST1");

if (listObj) {
    listObj.clearSearchList({searchMode : 'auto', maxRows: 30});
}

Limitations

List Control with Search Part